/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.generators.reports;

import org.bugstat.common.TimeInterval;
import org.bugstat.common.reports.Report;
import org.bugstat.common.reports.ReportType;
import org.bugstat.common.reports.ReportValueName;
import org.bugstat.generators.GeneratorsStrings;

/**
 * This is a base implementation for a timed report 
 *
 * @author Basil Shikin
 */
public abstract class TimedReportBase
    implements Report
{
    // Report time interval
    protected TimeInterval timeInterval = null;
    
    // Report display parameters
    protected boolean    isVisibleByDefault = false;
    protected String     name               = "";
    protected String     group              = GeneratorsStrings.TEXT_GROUP_OVERVIEW;
    
    protected ReportType reportType         = ReportType.GRAPH;
    
    public TimedReportBase()
    {
        setVisibleByDefault( false );        
    }
    
    public void setTimeInterval(TimeInterval timeInterval)
    {
        this.timeInterval = timeInterval;
    }

    public void setName(String reportName)
    {
        this.name = reportName;
    }
    
    public void setGroup(String reportGroup)
    {
        this.group = reportGroup;
    }
    
    public void setVisibleByDefault(boolean isVisibleByDefault)
    {
        this.isVisibleByDefault = isVisibleByDefault;
    }
    
    public void setReportType(ReportType reportType)
    {
        this.reportType = reportType;
    }
    
    public abstract int getMaxValue();
    
    public abstract ReportValueName getValueName();
    
    /*
     * BEGIN IMPLEMENTATION OF org.bugstat.common.reports.Report
     */
    public String getName()
    {
        return name;        
    }

    public boolean isVisibleByDefault() 
    {
        return isVisibleByDefault;
    }    

    public String getGroup()
    {
        return group;
    }

    public String getKeyName()
    {
        return GeneratorsStrings.TEXT_DATE;
    }

    public ReportType getType()
    {
        return reportType;
    }
    /*
     * END IMPLEMENTATION OF org.bugstat.common.reports.Report
     */
}
